home *** CD-ROM | disk | FTP | other *** search
/ SPACE 1 / SPACE - Library 1 - Volume 1.iso / demos / 8 / readme.doc / editor.doc < prev    next >
Encoding:
Text File  |  1985-06-09  |  6.1 KB  |  204 lines
  1.  
  2.  
  3.              Description of 4xFORTH Editor
  4.  
  5.  
  6.  
  7.  
  8. Overview
  9. --------
  10.  
  11.     The 4xFORTH editor, called ED, is a block oriented, cursor controlled
  12.     editor which uses the special function keys and the mouse provided by
  13.     the Atari 520 ST computer.
  14.  
  15.  
  16. Initiation
  17. ----------
  18.  
  19.     ED is invoked by the following command:
  20.  
  21.             <blk#> ED <cr>
  22.  
  23.     e.g.:
  24.  
  25.             10 ED <cr>
  26.  
  27.     The editor will then fetch the desired block, and place it on the
  28.     screen in the edit mode.
  29.  
  30.  
  31. Using the Mouse
  32. ---------------
  33.  
  34.     The mouse may be used to position the cursor within the block.  The
  35.     right key on the mouse will cause the currently diplayed block to be
  36.     saved on the mass storage device, and the next larger numbered block
  37.     in the logical stream of blocks will be fetched and displayed in edit
  38.     mode.  The left key will caused the currently displayed block to be
  39.     saved on the mass storage device, and the next smaller numbered block
  40.     to be fetched and displayed in the edit mode.
  41.  
  42.  
  43.  
  44.  
  45.  
  46. Two Insertion Modes
  47. -------------------
  48.  
  49.     ED has two key strike character insertion modes.  The first, called
  50.     overstrike or replace mode, causes new characters typed on the keys
  51.     to replace the character under the current position of the cursor.  
  52.     The insert mode causes the contents of the current line, beginning
  53.     with the character currently under the cursor, to be moved one cell
  54.     to the right.  The last character in the line is lost.  The new byte
  55.     is then inserted in the line under the current cursor position.
  56.  
  57.     The mode ED is currently running in is shown in the upper right
  58.     corner of the display.  It can be toggled to the other mode by
  59.     striking the control and N keys (^N) simultaneously.
  60.  
  61.  
  62. Commands that Change the Cursor Position
  63. ----------------------------------------
  64.  
  65.     ^I or TAB        Tab causes the cursor to be placed on the
  66.                 next tab stop.  Tab stops are set to every
  67.                 8th column.  Characters between the current
  68.                 cursor position and the next tab stop are
  69.                 not changed.  This is a nondestructive tab.
  70.  
  71.     ^O            This acts the same way the tab does, except
  72.                 that is replaces all characters between the
  73.                 current cursor position and the next tab
  74.                 stop with blanks.  This is a destructive tab.
  75.  
  76.     ^B            Blank the rest of the current line.  Replace
  77.                 the characters in the current line, beginning
  78.                 with the current cursor position, with blanks.
  79.                 leave the cursor at the beginning of the next
  80.                 line.
  81.  
  82.     ^P            Place the cursor at the 48th column of the 
  83.                 current line.  Do not change any characters
  84.                 in the current line.
  85.  
  86.     ^R            Place the cursor in the first column of the
  87.                 last line of the displayed block.  Do not
  88.                 change any characters.
  89.  
  90.     ^U            Place the cursor in the first column of the
  91.                 current line.  Do not change any characters.
  92.     
  93.  
  94.     HOME            Place the cursor in the first column of the
  95.                 first line of the currently displayed block.
  96.                 Dop not change any characters.
  97.  
  98.     cursor arrow keys    The cursor arrow keys in the keypad cluster
  99.                 are active and work as marked.
  100.  
  101.  
  102. Commands which Change Lines
  103. ---------------------------
  104.  
  105.     ^A or F3        Move the last line of the block into the cut
  106.                 buffer.  Scroll all lines beginning with the
  107.                 current one, down by one line.  Add a line of
  108.                 blanks at the current line.  This "add a line"
  109.                 function must be executed with the cursor on
  110.                 the first column of the desired line, else it
  111.                 will be ignored.
  112.  
  113.     ^T or F4        Delete the current line, placing it in the cut
  114.                 buffer.  Scroll all lines below it up by one
  115.                 line.  Insert a line of blanks into the bottom
  116.                 of the block.  This "delete a line" function
  117.                 must be executed with the cursor in the first
  118.                 column of the desired line, else it will be
  119.                 ignored.
  120.  
  121.     ^S or F9        Split the current line at the cursor. Place the
  122.                 last line in the block into the cut buffer. 
  123.                 scroll the lines below the current one down by
  124.                 one line.  Insert a line of blanks in the line
  125.                 below the current one.  Move the characters 
  126.                 after the cursor in the current line to their
  127.                 corresponding places in the line below, and
  128.                 replace them on the current line with blanks.
  129.  
  130.     ^Y            Wrap the current contents of the cut buffer
  131.                 into the block at the line specified by the
  132.                 current position of the cursor.  This is done
  133.                 in the following order:
  134.  
  135.                 1.  Move the contents of the current cut
  136.                     buffer into a temporary place.
  137.  
  138.                 2.  Move the last line of the block into the
  139.                     cut buffer.
  140.  
  141.                 3.  Scroll the lines below and including the
  142.                     current line down by one line.
  143.  
  144.                 4.  Move the contents of the temporary save
  145.                     area for the old cut buffer into the line
  146.                     specified by the position of the cursor.
  147.  
  148.                 Execution of this command must take place with
  149.                 the cursor in the first column of the desired
  150.                 line, else the command is ignored.
  151.  
  152.  
  153.  
  154.  
  155.  
  156. Cut Buffer Commands
  157. -------------------
  158.  
  159.     F5            Cut the characters from the beginning of the
  160.                 line to the current cursor position, and place
  161.                 them in the cut buffer.
  162.  
  163.     F6            Cut the characters from the current cursor
  164.                 position to the end of the current line and
  165.                 place them in the cut buffer.
  166.  
  167.     F7            Glue the characters in the cut buffer in front
  168.                 of the current cursor position.  This is an
  169.                 OVERWRITE operation.
  170.  
  171.     F8            Glue the characters in the cut buffer to the
  172.                 right of the current cursor position.  This is
  173.                 an OVERWRITE operation.
  174.  
  175.  
  176.  
  177.  
  178.  
  179. Deleting Characters
  180. -------------------
  181.  
  182.     ^D or F10        Delete the character under the current cursor
  183.                 position.  Move the characters following one
  184.                 to the right, and add a blank to the end of
  185.                 the current line.
  186.  
  187.     ^E or INSERT        Insert a blank at the current cursor position
  188.                 after moving all characters following one to
  189.                 the right.  The last character in the current
  190.                 line is lost.
  191.  
  192.  
  193. Exiting the Editor
  194. ------------------
  195.  
  196.     ^Z or F2        Save the currently displayed block to the
  197.                 mass storage device, and exit the editor.
  198.  
  199.     ^C or F1        Exit the editor without saving the currently
  200.                 displayed block to mass storage.  NOTE:  This
  201.                 is NOT recoverable!  The contents of the block
  202.                 being displayed is lost forever!
  203.  
  204.     ə